home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / proboard / doing112.zip / MANUAL.TXT < prev    next >
Text File  |  1996-04-25  |  13KB  |  247 lines
  1.   / | _ | \______________
  2.  /         \             \                                            
  3. (   o   o   )         /   |
  4.  \  _| |_  /        _(__   \______                                
  5. ┌ =(_/v\_)=__)_____(______\_______)─────────────────────────────────────────┐
  6. │ DOING112 - ProBoard 2.1x PEX  Version 1.12       (C)1996 Fe-line Software │
  7. │ Written by Faye Pearson, Docs by Sarah Pearson          (24th April 1996) │
  8. └───────────────────────────────────────────────────────────────────────────┘
  9.  
  10. DOING will only work on ProBoard Version 2.1x.
  11.  
  12. DOING will allow the User or Sysop to see what a User on any other Nodes is
  13. actually doing whilst online.
  14.  
  15. ProBoard only displays a few basic "What is this node doing" type messages
  16. when using MenuFunction 50 and 53.  DOING will allow you to setup your Menu's
  17. to display a much more detailed description of what the User is actually
  18. doing.
  19.  
  20. DOING checks the status of each Node every 3 seconds (by default) and displays
  21. an update.  You can change the time between updates.
  22.  
  23. DOING displays and works the same in ASCII (TTY) as it does in ANSI, AVATAR
  24. or AVT+.
  25.  
  26. If you want to remove the Fe-line Software copyright header, then run
  27. doing with the /NH paramerter.
  28.  
  29. With this archive comes a Windows 3.1x/Windows 95 program that allows you to
  30. view who is online and what they are doing, without having the Node window(s)
  31. open.  
  32.  
  33. ┌───────────────────────────────────────────────────────────────────────────┐
  34. │ DOING : Installation                             (C)1996 Fe-line Software │
  35. └───────────────────────────────────────────────────────────────────────────┘
  36.  
  37. Copy DOING.PEX to your ProBoard PEX directory.  You may rename the PEX.
  38. (You may put DOING into a subdirectory off your PEX directory if you wish)
  39.  
  40. Copy DOING.A?? to your ProBoard TextFiles directory.  Do not rename these
  41. files.
  42. (You may put DOING.A?? into a subdirectory off your TextFiles directory if
  43. you wish)
  44.  
  45. The DOING.A?? files included with this archive are just samples and only fit
  46. 2 Nodes.  You can use your own .A?? files as long as you use the following %
  47. codes to display the Node Info.
  48.  
  49. You can display as many Node Info lines as you wish, your only limitation is
  50. screen size.
  51.  
  52. %#  Node Number
  53. %N  Name of Person online
  54. %C  City of the Person online
  55. %D  What they are Doing
  56.  
  57. If you put . in between the % and the letter then you can specify the
  58. length of the field.
  59.  
  60. eg, %................N   will display the Name field at a maximum length of
  61. 20 characters.  The % and N are included in the length, hence only 18 .'s.
  62.  
  63. If the DOING.A?? files are not located, then DOING will use a hardcoded
  64. screen display.
  65.  
  66. See the .A?? files for an example of how these codes are implemented.
  67.  
  68. FastLog/IEMSI now has OS/2 Doing Support included.  If you wish to have this
  69. support, insert the following into your AUTOEXEC.BAT file :
  70.  
  71.     SET OS2DOING=YES
  72.  
  73. Only the first 12 characters of the DOING description can be shown in the
  74. Window Title.  We hope to fix this in later version.
  75.  
  76. ┌───────────────────────────────────────────────────────────────────────────┐
  77. │ DOING : How to use                               (C)1996 Fe-line Software │
  78. └───────────────────────────────────────────────────────────────────────────┘
  79.  
  80. DOING MENU
  81. DOING ? [secs] /NH
  82. DOING "<text to display to user>" [MenuFunction Number] [Data]
  83.  
  84. MENU                      will set DOING to the current menu name.
  85. ?                         Display the DOING Node Status
  86. [secs]                    Number of seconds between updates [optional]
  87.                           (default is 3 seconds and the minimum is 3 seconds)
  88. /NH                       Do NOT display the Fe-line Software header.
  89. <text to display to user> is the text description you would like to display
  90.                           about what the User is doing.  This can be upto 30
  91.                           characters in length.
  92. [MenuFunction Number]     is the ProBoard Menu Function you would like to
  93.                           perform. [optional]
  94. [Data]                    is the Data Parameters for the MenuFunction Number.
  95.                           [optional]
  96. Examples:
  97.  
  98. Our example user is called Peter Pan and he is in the menu defined in
  99. "MESSAGE.PBM".
  100.  
  101. 1)      Set the DOING Descriptive Text to the current Menu Name.
  102.  
  103.         There are two ways of doing this.
  104.  
  105.         a)  DOING MENU - This will display "Peter Pan in MESSAGE Menu"
  106.            (MESSAGE is the .PBM filename as seen in ProCfg)
  107.  
  108.             or
  109.  
  110.         b)  DOING "is in the Message Menu" - This will display "Peter Pan is
  111.             in the Message Menu".
  112.  
  113. 2)      Set the DOING Descriptive Text to the selected Menu Option and then
  114.         perform that Menu Option.
  115.  
  116.         There are two ways of doing this.
  117.  
  118.         a)  To display "Peter Pan is Entering a New Message" :
  119.             DOING "is Entering a New Message" 27 *
  120.             27 is the MenuFunction Number as specified in ProCfg and * is the
  121.             parameter the Menu Function Number requires to run.
  122.  
  123. ╔═══════════════════════════════════[ MESS ]═════════════════════════════════╗
  124. ║ 0        1         2         3         4         5         6         7     ║
  125. ║ 12345678901234567890123456789012345678901234567890123456789012345678901234 ║
  126. ║          [^E^] Enter New Message                                           ║
  127. ║                                                                            ║
  128. ║ Color    : White on Black             Example Text                         ║
  129. ║                                                                            ║
  130. ║ HotKey   : E                                                               ║
  131. ║ Function : 60 - Run ProBoard PEX File                                      ║
  132. ║ Data     : DOING "Entering a New Message" 27 *                             ║
  133. ║                                                                            ║
  134. ║ Min.Level: 0                               Nodes: All nodes                ║
  135. ║ Max.Level: 0                                                               ║
  136. ║ Flags    : --------------------------------                                ║
  137. ║ Min. Age : 0                   Password required: No                       ║
  138. ║ Max. Age : 0                            Password:                          ║
  139. ║ Sex      : Don't Care                                                      ║
  140. ║ Time Left: 0                          ┌─RIP───────────────┐                ║
  141. ║ Time Onl.: 0                          │ Show remote : No  │                ║
  142. ║ Timeframe: Fully enabled              │ Show local  : Yes │                ║
  143. ║ Min.Speed: 0                          │ Reset screen: Yes │                ║
  144. ║ Max.Speed: 0                          └───────────────────┘                ║
  145. ║                                                                            ║
  146. ╚════════════════════════════════════════════════════════════════════════════╝
  147.  
  148.         b)  To display "Peter Pan is Entering a Message":
  149.  
  150.             This way need 2 menu option entries with the same HotKey.  This
  151.             means the DOING description is entered as the first Menu Option
  152.             and the actual existing Menu Option is executed afterwards.
  153.  
  154. ╔═══════════════════════════════════[ MESS ]═════════════════════════════════╗
  155. ║ 0        1         2         3         4         5         6         7     ║
  156. ║ 12345678901234567890123456789012345678901234567890123456789012345678901234 ║
  157. ║          [^E^] Enter New Message                                           ║
  158. ║                                                                            ║
  159. ║ Color    : White on Black             Example Text                         ║
  160. ║                                                                            ║
  161. ║ HotKey   : E                                                               ║
  162. ║ Function : 60 - Run ProBoard PEX File                                      ║
  163. ║ Data     : DOING "Entering a New Message"                                  ║
  164. ║                                                                            ║
  165. ║ Min.Level: 0                               Nodes: All nodes                ║
  166. ║ Max.Level: 0                                                               ║
  167. ║ Flags    : --------------------------------                                ║
  168. ║ Min. Age : 0                   Password required: No                       ║
  169. ║ Max. Age : 0                            Password:                          ║
  170. ║ Sex      : Don't Care                                                      ║
  171. ║ Time Left: 0                          ┌─RIP───────────────┐                ║
  172. ║ Time Onl.: 0                          │ Show remote : No  │                ║
  173. ║ Timeframe: Fully enabled              │ Show local  : Yes │                ║
  174. ║ Min.Speed: 0                          │ Reset screen: Yes │                ║
  175. ║ Max.Speed: 0                          └───────────────────┘                ║
  176. ║                                                                            ║
  177. ╚════════════════════════════════════════════════════════════════════════════╝
  178. ╔═══════════════════════════════════[ MESS ]═════════════════════════════════╗
  179. ║ 0        1         2         3         4         5         6         7     ║
  180. ║ 12345678901234567890123456789012345678901234567890123456789012345678901234 ║
  181. ║ ;                                                                          ║
  182. ║                                                                            ║
  183. ║ Color    : White on Black             Example Text                         ║
  184. ║                                                                            ║
  185. ║ HotKey   : E                                                               ║
  186. ║ Function : 27 - Enter New Message                                          ║
  187. ║ Data     : *                                                               ║
  188. ║                                                                            ║
  189. ║ Min.Level: 0                               Nodes: All nodes                ║
  190. ║ Max.Level: 0                                                               ║
  191. ║ Flags    : --------------------------------                                ║
  192. ║ Min. Age : 0                   Password required: No                       ║
  193. ║ Max. Age : 0                            Password:                          ║
  194. ║ Sex      : Don't Care                                                      ║
  195. ║ Time Left: 0                          ┌─RIP───────────────┐                ║
  196. ║ Time Onl.: 0                          │ Show remote : No  │                ║
  197. ║ Timeframe: Fully enabled              │ Show local  : Yes │                ║
  198. ║ Min.Speed: 0                          │ Reset screen: Yes │                ║
  199. ║ Max.Speed: 0                          └───────────────────┘                ║
  200. ║                                                                            ║
  201. ╚════════════════════════════════════════════════════════════════════════════╝
  202.  
  203.             This way is only really useful if the PEX or MenuFunction you
  204.             wish to use is exceptionally long.
  205.  
  206.             We recommend you use method 1 above.
  207.  
  208. 3)  Displaying the current DOING info for the Nodes and update this info
  209.     every 4 seconds.
  210.  
  211.     There is only one way of doing this.
  212.  
  213.     DOING ? 4
  214.  
  215.     This will display the DOING.A?? file to the User and update every 4
  216.     seconds.   The minimum update is 3 seconds
  217.  
  218.     If you don't want the Fe-line Software Copyright header displayed, then
  219.     simply add /NH to the Data line.
  220.  
  221.     DOING ? /NH
  222.  
  223. You should hopefully be able to get the idea of how DOING works from the
  224. above 3 examples.
  225.  
  226.  
  227. DOING is FreeWare.  This means that we require *no* registration fee for
  228. you to use this PEX for as long as you wish.  We would like to hear from you
  229. if you do decide to use this PEX. :-)
  230.  
  231.  
  232. This PEX is supplied "as is" and we will not be held responsible for any
  233. damage caused by this PEX.  It works on our BBS ok, so that is the only
  234. guarantee given :-)
  235.  
  236. --
  237. Sarah & Faye, sysops@fe-line.demon.co.uk           Home of Fe-line Software
  238. http://www.win-uk.net/~fe-line       ftp://ftp.win-uk.net/pub/users/fe-line
  239. ProBoard *UK* Registration and Support Site              ProBoard Beta Team
  240. TGPBN Net Coordinators                        PSN *UK* Regional Coordinator
  241.  
  242. ┌───────────────────────────────────────────────────────────────────────────┐
  243. │               We can be reached on the following Node Numbers.            │
  244. │  (2:254/278 Fido / 311:21/0 PSN / 173:902/300 DqP-Net / 752:752/0 TGPBN)  │
  245. │                     sysops@fe-line.demon.co.uk / Internet                 │
  246. └───────────────────────────────────────────────────────────────────────────┘
  247.